docs: README examples for pymat.search + Vis adapter methods#87
Open
docs: README examples for pymat.search + Vis adapter methods#87
Conversation
Adds two new sections (auto-generated from test_readme_examples.py): - Finding Materials by Name — pymat.search(), multi-token queries, limit=, grade/parent matching (3.3.0 feature). - Exporting Materials to Three.js / glTF / MaterialX — method form on Material.vis, module-level equivalent (3.2.1 feature). Covers the features added in 3.2.1 + 3.3.0 that the README was silent on. Tests double as doc and executable examples.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
README was silent on the two features landed in 3.2.1 + 3.3.0. Add runnable examples via
tests/test_readme_examples.py(auto-regeneratesREADME.md).Covers:
pymat.search()— fuzzy domain-library find (3.3.0). Examples for single-word, multi-token, grade match, andlimit=.Material.vis.to_threejs()/.to_gltf()— method-form adapter sugar (3.2.1). Example showing it alongside the module-levelpymat.vis.to_gltf(m)equivalent.Test plan
scripts/generate_readme.pyemits the new sections intoREADME.md.README.md matches test_readme_examples.pypre-commit hook passes.